Azure AI Face API (stable:v1.2)

2025/07/25 • 2 updated methods

LivenessSessionOperations_CreateLivenessSession (updated)
Description :  A session is best for client device scenarios where developers want to authorize a client device to perform only a liveness detection without granting full access to their resource. Created sessions have a limited life span and only authorize clients to perform the desired action before access is expired. Permissions includes... > * * A token lifetime of 10 minutes. > [!NOTE] > Client access can be revoked by deleting the session using the Delete Liveness Session operation. To retrieve a result, use the Get Liveness Session. To audit the individual requests that a client has made to your resource, use the List Liveness Session Audit Entries.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LivenessSessionOperations_CreateLivenessSession",
  "Description": {
    "new": "A session is best for client device scenarios where developers want to authorize a client device to perform only a liveness detection without granting full access to their resource. Created sessions have a limited life span and only authorize clients to perform the desired action before access is expired.\n\nPermissions includes...\n>\n*\n  * A token lifetime of 10 minutes.\n\n> [!NOTE]\n> Client access can be revoked by deleting the session using the Delete Liveness Session operation. To retrieve a result, use the Get Liveness Session. To audit the individual requests that a client has made to your resource, use the List Liveness Session Audit Entries.",
    "old": "A session is best for client device scenarios where developers want to authorize a client device to perform only a liveness detection without granting full access to their resource. Created sessions have a limited life span and only authorize clients to perform the desired action before access is expired.\n\nPermissions includes...\n>\n*\n  * Ability to call /detectLiveness/singleModal for up to 3 retries.\n  * A token lifetime of 10 minutes.\n\n> [!NOTE]\n> Client access can be revoked by deleting the session using the Delete Liveness Session operation. To retrieve a result, use the Get Liveness Session. To audit the individual requests that a client has made to your resource, use the List Liveness Session Audit Entries."
  }
}

⚼ Request

POST:  /detectLiveness-sessions
{
body:
{
Description: Body parameter. ,
Required: True ,
}
{
livenessOperationMode:
{
Description: Type of liveness mode the client should follow. ,
Enum:
{
Passive: Utilizes a passive liveness technique that requires no additional actions from the user. Requires normal indoor lighting and high screen brightness for optimal performance. And thus, this mode has a narrow operational envelope and will not be suitable for scenarios that requires the end-user's to be in bright lighting conditions. Note: this is the only supported mode for the Mobile (iOS and Android) solution. ,
PassiveActive: This mode utilizes a hybrid passive or active liveness technique that necessitates user cooperation. It is optimized to require active motion only under suboptimal lighting conditions. Unlike the passive mode, this mode has no lighting restrictions, and thus offering a broader operational envelope. This mode is preferable on Web based solutions due to the lack of automatic screen brightness control available on browsers which hinders the Passive mode's operational envelope on Web based solutions. ,
}
,
Required: True ,
}
enum ,
deviceCorrelationIdSetInClient:
{
Description: Whether or not to allow client to set their own 'deviceCorrelationId' via the Vision SDK. Default is false, and 'deviceCorrelationId' must be set in this request body. ,
Required: False ,
}
boolean ,
enableSessionImage:
{
Description: Whether or not store the session image. ,
Required: False ,
}
boolean ,
livenessModelVersion:
{
Description: The model version used for liveness classification. This is an optional parameter, and if this is not specified, then the latest supported model version will be chosen ,
Enum:
{
2024-11-15: No description available. ,
}
,
Required: False ,
}
enum ,
deviceCorrelationId:
{
Description: Unique Guid per each end-user device. This is to provide rate limiting and anti-hammering. If 'deviceCorrelationIdSetInClient' is true in this request, this 'deviceCorrelationId' must be null. ,
Required: False ,
}
string ,
authTokenTimeToLiveInSeconds:
{
Description: Seconds the session should last for. Range is 60 to 86400 seconds. Default value is 600. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

{
sessionId:
{
Description: The unique ID to reference this session. ,
Required: True ,
}
string ,
authToken:
{
Description: Bearer token to provide authentication for the Vision SDK running on a client application. This Bearer token has limited permissions to perform only the required action and expires after the TTL time. It is also auditable. ,
Required: True ,
}
string ,
status:
{
Description: The current status of the session. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
modelVersion:
{
Description: The model version used for liveness classification. This is an optional parameter, and if this is not specified, then the latest supported model version will be chosen ,
Enum:
{
2024-11-15: No description available. ,
}
,
Required: False ,
}
enum ,
results:
{
Description: The results of the liveness session. ,
Required: True ,
}
{
attempts:
{
Description: The attempts data of underlying liveness call with the session. ,
Required: True ,
}
[
{
attemptId:
{
Description: The attempt ID, start from 1. ,
Format: int32 ,
Required: True ,
}
integer ,
attemptStatus:
{
Description: The status of the attempt. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
result:
{
Description: The result of the liveness call, will be null if there is error. ,
Required: False ,
}
{
livenessDecision:
{
Description: The liveness classification for the target face. ,
Enum:
{
uncertain: The algorithm could not classify the target face as either real or spoof. ,
realface: The algorithm has classified the target face as real. ,
spoofface: The algorithm has classified the target face as a spoof. ,
}
,
Required: False ,
}
enum ,
targets:
{
Description: Targets used for liveness classification. ,
Required: True ,
}
{
color:
{
Description: The target from color image used for liveness classification. ,
Required: True ,
}
{
faceRectangle:
{
Description: The face region where the liveness classification was made on. ,
Required: True ,
}
{
top:
{
Description: The distance from the top edge if the image to the top edge of the rectangle, in pixels. ,
Format: int32 ,
Required: True ,
}
integer ,
left:
{
Description: The distance from the left edge if the image to the left edge of the rectangle, in pixels. ,
Format: int32 ,
Required: True ,
}
integer ,
width:
{
Description: The width of the rectangle, in pixels. ,
Format: int32 ,
Required: True ,
}
integer ,
height:
{
Description: The height of the rectangle, in pixels. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
digest:
{
Description: The server calculated digest for this request. If the client reported digest differs from the server calculated digest, then the message integrity between the client and service has been compromised and the result should not be trusted. For more information, see how to guides on how to leverage this value to secure your end-to-end solution. ,
Required: True ,
}
string ,
sessionImageId:
{
Description: The image ID of the session request. ,
Required: False ,
}
string ,
}
,
error:
{
Description: The error of the liveness call, will be null if there is result. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
targets:
{
Description: Targets used for liveness classification. ,
Required: True ,
}
{
color:
{
Description: The target from color image used for liveness classification. ,
Required: True ,
}
{
faceRectangle:
{
Description: The face region where the liveness classification was made on. ,
Required: True ,
}
{
top:
{
Description: The distance from the top edge if the image to the top edge of the rectangle, in pixels. ,
Format: int32 ,
Required: True ,
}
integer ,
left:
{
Description: The distance from the left edge if the image to the left edge of the rectangle, in pixels. ,
Format: int32 ,
Required: True ,
}
integer ,
width:
{
Description: The width of the rectangle, in pixels. ,
Format: int32 ,
Required: True ,
}
integer ,
height:
{
Description: The height of the rectangle, in pixels. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
}
,
}
,
}
LivenessSessionOperations_CreateLivenessWithVerifySession (updated)
Description :  A session is best for client device scenarios where developers want to authorize a client device to perform only a liveness detection without granting full access to their resource. Created sessions have a limited life span and only authorize clients to perform the desired action before access is expired. Permissions includes... > * * A token lifetime of 10 minutes. > [!NOTE] > > * > * Client access can be revoked by deleting the session using the Delete Liveness With Verify Session operation. > * To retrieve a result, use the Get Liveness With Verify Session. > * To audit the individual requests that a client has made to your resource, use the List Liveness With Verify Session Audit Entries.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LivenessSessionOperations_CreateLivenessWithVerifySession",
  "Description": {
    "new": "A session is best for client device scenarios where developers want to authorize a client device to perform only a liveness detection without granting full access to their resource. Created sessions have a limited life span and only authorize clients to perform the desired action before access is expired.\n\nPermissions includes...\n>\n*\n  * A token lifetime of 10 minutes.\n\n> [!NOTE]\n>\n> *\n>   * Client access can be revoked by deleting the session using the Delete Liveness With Verify Session operation.\n>   * To retrieve a result, use the Get Liveness With Verify Session.\n>   * To audit the individual requests that a client has made to your resource, use the List Liveness With Verify Session Audit Entries.",
    "old": "A session is best for client device scenarios where developers want to authorize a client device to perform only a liveness detection without granting full access to their resource. Created sessions have a limited life span and only authorize clients to perform the desired action before access is expired.\n\nPermissions includes...\n>\n*\n  * Ability to call /detectLivenessWithVerify/singleModal for up to 3 retries.\n  * A token lifetime of 10 minutes.\n\n> [!NOTE]\n>\n> *\n>   * Client access can be revoked by deleting the session using the Delete Liveness With Verify Session operation.\n>   * To retrieve a result, use the Get Liveness With Verify Session.\n>   * To audit the individual requests that a client has made to your resource, use the List Liveness With Verify Session Audit Entries."
  }
}

⚼ Request

POST:  /detectLivenessWithVerify-sessions
{
livenessOperationMode:
{
Description: Type of liveness mode the client should follow. ,
Required: True ,
}
string ,
deviceCorrelationIdSetInClient:
{
Description: Whether or not to allow client to set their own 'deviceCorrelationId' via the Vision SDK. Default is false, and 'deviceCorrelationId' must be set in this request body. ,
Required: False ,
}
boolean ,
enableSessionImage:
{
Description: Whether or not store the session image. ,
Required: False ,
}
boolean ,
livenessModelVersion:
{
Description: The model version used for liveness classification. This is an optional parameter, and if this is not specified, then the latest supported model version will be chosen ,
Required: False ,
}
string ,
returnVerifyImageHash:
{
Description: Whether or not return the verify image hash. ,
Required: False ,
}
boolean ,
verifyConfidenceThreshold:
{
Description: Threshold for confidence of the face verification. Please refer to the documentation for more details. https://learn.microsoft.com/legal/cognitive-services/face/characteristics-and-limitations?context=%2Fazure%2Fai-services%2Fcomputer-vision%2Fcontext%2Fcontext#recognition-confidence-score ,
Format: float ,
Required: False ,
}
number ,
verifyImage:
{
Description: The image stream for verify. Content-Disposition header field for this part must have filename. ,
Required: True ,
}
file ,
deviceCorrelationId:
{
Description: Unique Guid per each end-user device. This is to provide rate limiting and anti-hammering. If 'deviceCorrelationIdSetInClient' is true in this request, this 'deviceCorrelationId' must be null. ,
Required: False ,
}
string ,
authTokenTimeToLiveInSeconds:
{
Description: Seconds the session should last for. Range is 60 to 86400 seconds. Default value is 600. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
sessionId:
{
Description: The unique ID to reference this session. ,
Required: True ,
}
string ,
authToken:
{
Description: Bearer token to provide authentication for the Vision SDK running on a client application. This Bearer token has limited permissions to perform only the required action and expires after the TTL time. It is also auditable. ,
Required: True ,
}
string ,
status:
{
Description: The current status of the session. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
modelVersion:
{
Description: The model version used for liveness classification. This is an optional parameter, and if this is not specified, then the latest supported model version will be chosen ,
Enum:
{
2024-11-15: No description available. ,
}
,
Required: False ,
}
enum ,
results:
{
Description: The results of the liveness with verify session. ,
Required: True ,
}
{
verifyReferences:
{
Description: The references used for face verification. ,
Required: True ,
}
[
{
referenceType:
{
Description: The image type which contains the face rectangle where the liveness classification was made on. ,
Enum:
{
Color: Color image. ,
Infrared: Infrared image. ,
Depth: Depth image. ,
}
,
Required: True ,
}
enum ,
faceRectangle:
{
Description: The face region where the comparison image's classification was made. ,
Required: True ,
}
{
top:
{
Description: The distance from the top edge if the image to the top edge of the rectangle, in pixels. ,
Format: int32 ,
Required: True ,
}
integer ,
left:
{
Description: The distance from the left edge if the image to the left edge of the rectangle, in pixels. ,
Format: int32 ,
Required: True ,
}
integer ,
width:
{
Description: The width of the rectangle, in pixels. ,
Format: int32 ,
Required: True ,
}
integer ,
height:
{
Description: The height of the rectangle, in pixels. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
qualityForRecognition:
{
Description: Quality of face image for recognition. ,
Enum:
{
low: Low quality. ,
medium: Medium quality. ,
high: High quality. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
attempts:
{
Description: The attempts data of underlying liveness with verify call with the session. ,
Required: True ,
}
[
{
attemptId:
{
Description: The attempt ID, start from 1. ,
Format: int32 ,
Required: True ,
}
integer ,
attemptStatus:
{
Description: The status of the attempt. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
result:
{
Description: The result of the liveness with verify call, will be null if there is error. ,
Required: False ,
}
{
livenessDecision:
{
Description: The liveness classification for the target face. ,
Enum:
{
uncertain: The algorithm could not classify the target face as either real or spoof. ,
realface: The algorithm has classified the target face as real. ,
spoofface: The algorithm has classified the target face as a spoof. ,
}
,
Required: False ,
}
enum ,
targets:
{
Description: Targets used for liveness classification. ,
Required: True ,
}
{
color:
{
Description: The target from color image used for liveness classification. ,
Required: True ,
}
{
faceRectangle:
{
Description: The face region where the liveness classification was made on. ,
Required: True ,
}
{
top:
{
Description: The distance from the top edge if the image to the top edge of the rectangle, in pixels. ,
Format: int32 ,
Required: True ,
}
integer ,
left:
{
Description: The distance from the left edge if the image to the left edge of the rectangle, in pixels. ,
Format: int32 ,
Required: True ,
}
integer ,
width:
{
Description: The width of the rectangle, in pixels. ,
Format: int32 ,
Required: True ,
}
integer ,
height:
{
Description: The height of the rectangle, in pixels. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
digest:
{
Description: The server calculated digest for this request. If the client reported digest differs from the server calculated digest, then the message integrity between the client and service has been compromised and the result should not be trusted. For more information, see how to guides on how to leverage this value to secure your end-to-end solution. ,
Required: True ,
}
string ,
sessionImageId:
{
Description: The image ID of the session request. ,
Required: False ,
}
string ,
verifyResult:
{
Description: The face verification output. Only available when the request is liveness with verify. ,
Required: False ,
}
{
matchConfidence:
{
Description: The target face liveness face and comparison image face verification confidence. ,
Format: float ,
Required: True ,
}
number ,
isIdentical:
{
Description: Whether the target liveness face and comparison image face match. ,
Required: True ,
}
boolean ,
}
,
verifyImageHash:
{
Description: The sha256 hash of the verify-image in the request. ,
Required: False ,
}
string ,
}
,
error:
{
Description: The error of the liveness with verify call, will be null if there is result. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
targets:
{
Description: Targets used for liveness classification. ,
Required: True ,
}
{
color:
{
Description: The target from color image used for liveness classification. ,
Required: True ,
}
{
faceRectangle:
{
Description: The face region where the liveness classification was made on. ,
Required: True ,
}
{
top:
{
Description: The distance from the top edge if the image to the top edge of the rectangle, in pixels. ,
Format: int32 ,
Required: True ,
}
integer ,
left:
{
Description: The distance from the left edge if the image to the left edge of the rectangle, in pixels. ,
Format: int32 ,
Required: True ,
}
integer ,
width:
{
Description: The width of the rectangle, in pixels. ,
Format: int32 ,
Required: True ,
}
integer ,
height:
{
Description: The height of the rectangle, in pixels. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
}
,
}
,
}